Entity Breakable

Breakable is the Entity definition for a breakable world object (e.g.

barricade). Subclass of Entity.

Functions

GetAttribute (attrib) GetAttribute returns the value of the named attribute from the Breakable entity.
GetHP () GetHP returns the current hit points of the Breakable entity.
GetMinDamage () GetMinDamage returns the minimum damage done to nearby entities when this Breakable is destroyed.
GetMaxDamage () GetMaxDamage returns the maximum damage done to nearby entities when this Breakable is destroyed.
GetDamageRadius () GetDamageRadius returns the radius of damage done to nearby entities when this Breakable is destroyed.
GetVariant () GetVariant returns the ammo variant type used when calculating damage from this Breakable to nearby entities.
GetPrimaryDamageType () GetPrimaryDamageType returns the main damage type this breakable will cause (e.g.
GetSecondaryDamageType () GetSecondaryDamageType returns the secondary damage type this breakable will cause, if any (e.g.
EtherealWhenDead () EtherealWhenDead returns true if the Breakable is able to be moved through when destroyed.
IsMetal () IsMetal returns true if the Breakable is to be treated as if made of metal.


Functions

GetAttribute (attrib)
GetAttribute returns the value of the named attribute from the Breakable entity.

Parameters:

  • attrib The name of the attribute, as shown in the Fallout: Tactics entity editor.

Returns:

    The value of the requested attribute. May be a boolean for tag_* fields or traits; otherwise is an integer value.
GetHP ()
GetHP returns the current hit points of the Breakable entity.

Returns:

    The current HP of the breakable.
GetMinDamage ()
GetMinDamage returns the minimum damage done to nearby entities when this Breakable is destroyed.

Returns:

    The minimum damage done to nearby entities.
GetMaxDamage ()
GetMaxDamage returns the maximum damage done to nearby entities when this Breakable is destroyed.

Returns:

    The maximum damage done to nearby entities.
GetDamageRadius ()
GetDamageRadius returns the radius of damage done to nearby entities when this Breakable is destroyed.

Returns:

    The radius of damage done to nearby entities.
GetVariant ()
GetVariant returns the ammo variant type used when calculating damage from this Breakable to nearby entities.

Returns:

    A string indicating the ammo variant type.
GetPrimaryDamageType ()
GetPrimaryDamageType returns the main damage type this breakable will cause (e.g. "energy").

Returns:

    A string indicating the main dmaage type.
GetSecondaryDamageType ()
GetSecondaryDamageType returns the secondary damage type this breakable will cause, if any (e.g. "poison").

Returns:

    A string indicating the secondary dmaage type, or "normal" if none.
EtherealWhenDead ()
EtherealWhenDead returns true if the Breakable is able to be moved through when destroyed.

Returns:

    A boolean indicating if the Breakable is ethereal when destroyed.
IsMetal ()
IsMetal returns true if the Breakable is to be treated as if made of metal.

Returns:

    A boolean indicating if the Breakable is made of metal.
generated by LDoc 1.4.6 Last updated 2021-05-07 19:14:47